<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>http::message::header_type</title>
<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../index.html" title="Chapter 1. Boost.Beast">
<link rel="up" href="../boost__beast__http__message.html" title="http::message">
<link rel="prev" href="../boost__beast__http__message.html" title="http::message">
<link rel="next" href="body_type.html" title="http::message::body_type">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../boost__beast__http__message.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__message.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="body_type.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="beast.ref.boost__beast__http__message.header_type"></a><a class="link" href="header_type.html" title="http::message::header_type">http::message::header_type</a>
</h5></div></div></div>
<p>
          <a class="indexterm" name="idm34037"></a>
        </p>
<p>
          The base class used to hold the header portion of the message.
        </p>
<h6>
<a name="beast.ref.boost__beast__http__message.header_type.h0"></a>
          <span class="phrase"><a name="beast.ref.boost__beast__http__message.header_type.synopsis"></a></span><a class="link" href="header_type.html#beast.ref.boost__beast__http__message.header_type.synopsis">Synopsis</a>
        </h6>
<pre class="programlisting"><span class="keyword">using</span> <span class="identifier">header_type</span> <span class="special">=</span> <span class="identifier">header</span><span class="special">&lt;</span> <span class="identifier">isRequest</span><span class="special">,</span> <span class="identifier">Fields</span> <span class="special">&gt;;</span>
</pre>
<h6>
<a name="beast.ref.boost__beast__http__message.header_type.h1"></a>
          <span class="phrase"><a name="beast.ref.boost__beast__http__message.header_type.types"></a></span><a class="link" href="header_type.html#beast.ref.boost__beast__http__message.header_type.types">Types</a>
        </h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                  <p>
                    Name
                  </p>
                </th>
<th>
                  <p>
                    Description
                  </p>
                </th>
</tr></thead>
<tbody>
<tr>
<td>
                  <p>
                    <span class="bold"><strong><a class="link" href="../boost__beast__http__header/fields_type.html" title="http::header::fields_type">fields_type</a></strong></span>
                  </p>
                </td>
<td>
                  <p>
                    The type representing the fields.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <span class="bold"><strong><a class="link" href="../boost__beast__http__header/is_request.html" title="http::header::is_request">is_request</a></strong></span>
                  </p>
                </td>
<td>
                  <p>
                    Indicates if the header is a request or response.
                  </p>
                </td>
</tr>
</tbody>
</table></div>
<h6>
<a name="beast.ref.boost__beast__http__message.header_type.h2"></a>
          <span class="phrase"><a name="beast.ref.boost__beast__http__message.header_type.member_functions"></a></span><a class="link" href="header_type.html#beast.ref.boost__beast__http__message.header_type.member_functions">Member
          Functions</a>
        </h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                  <p>
                    Name
                  </p>
                </th>
<th>
                  <p>
                    Description
                  </p>
                </th>
</tr></thead>
<tbody>
<tr>
<td>
                  <p>
                    <span class="bold"><strong><a class="link" href="../boost__beast__http__header/header.html" title="http::header::header">header</a></strong></span>
                  </p>
                </td>
<td>
                  <p>
                    Constructor.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <span class="bold"><strong><a class="link" href="../boost__beast__http__header/method.html" title="http::header::method">method</a></strong></span>
                  </p>
                </td>
<td>
                  <p>
                    Return the request-method verb. <br> <span class="silver">—</span><br>
                    Set the request-method.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <span class="bold"><strong><a class="link" href="../boost__beast__http__header/method_string.html" title="http::header::method_string">method_string</a></strong></span>
                  </p>
                </td>
<td>
                  <p>
                    Return the request-method as a string. <br> <span class="silver">—</span><br>
                    Set the request-method.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <span class="bold"><strong><a class="link" href="../boost__beast__http__header/operator_eq_.html" title="http::header::operator=">operator=</a></strong></span>
                  </p>
                </td>
<td>
                  <p>
                    Assignment.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <span class="bold"><strong><a class="link" href="../boost__beast__http__header/reason.html" title="http::header::reason">reason</a></strong></span>
                  </p>
                </td>
<td>
                  <p>
                    Return the response reason-phrase. <br> <span class="silver">—</span><br>
                    Set the response reason-phrase (deprecated)
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <span class="bold"><strong><a class="link" href="../boost__beast__http__header/result.html" title="http::header::result">result</a></strong></span>
                  </p>
                </td>
<td>
                  <p>
                    The response status-code result. <br> <span class="silver">—</span><br>
                    Set the response status-code. <br> <span class="silver">—</span><br>
                    Set the response status-code as an integer.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <span class="bold"><strong><a class="link" href="../boost__beast__http__header/result_int.html" title="http::header::result_int">result_int</a></strong></span>
                  </p>
                </td>
<td>
                  <p>
                    The response status-code expressed as an integer.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <span class="bold"><strong><a class="link" href="../boost__beast__http__header/target.html" title="http::header::target">target</a></strong></span>
                  </p>
                </td>
<td>
                  <p>
                    Returns the request-target string. <br> <span class="silver">—</span><br>
                    Set the request-target string.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <span class="bold"><strong><a class="link" href="../boost__beast__http__header/version.html" title="http::header::version">version</a></strong></span>
                  </p>
                </td>
<td>
                  <p>
                    Return the HTTP-version. <br> <span class="silver">—</span><br>
                    Set the HTTP-version.
                  </p>
                </td>
</tr>
</tbody>
</table></div>
<p>
          This container is derived from the <code class="computeroutput"><span class="identifier">Fields</span></code>
          template type. To understand all of the members of this class it is necessary
          to view the declaration for the <code class="computeroutput"><span class="identifier">Fields</span></code>
          type. When using the default fields container, those declarations are in
          <a class="link" href="../boost__beast__http__fields.html" title="http::fields"><code class="computeroutput"><span class="identifier">fields</span></code></a>.
          Newly constructed header objects have version set to HTTP/1.1. Newly constructed
          response objects also have result code set to <a class="link" href="../boost__beast__http__status.html" title="http::status"><code class="computeroutput"><span class="identifier">status</span><span class="special">::</span><span class="identifier">ok</span></code></a>. A <code class="computeroutput"><span class="identifier">header</span></code>
          includes the start-line and header-fields.
        </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
      Falco<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../boost__beast__http__message.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__message.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="body_type.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
